subscribed.event

An event structure representing a one-to-many function/delegate relationship.

  • Event

    Declaration

    struct Event(T) if (isCallable!T);

    An event structure representing a one-to-many function/delegate relationship. It mimics a function by overriding the call operator. It also implements the bidirectional range interface.

    Parameters

    T

    The listener type this event contains.

    • ListenerType

      Declaration

      alias ListenerType = T;

      The listeners' type.

    • ReturnType

      Declaration

      alias ReturnType = void;

      The event's return type.

    • ParamTypes

      Declaration

      alias ParamTypes = ParameterTypeTuple!T;

      The event's argument type tuple.

    • size

      Declaration

      const size_t size();

      The number of listeners.

    • listeners

      Declaration

      auto listeners();

      A range array of all the listeners.

    • empty

      Declaration

      const bool empty();

      A boolean property indicating whether there are listeners. Part of the bidirectional range interface.

    • front

      Declaration

      const T front();

      Get the first listener or throw an error if there are no listeners. Part of the bidirectional range interface.

    • popFront

      Declaration

      void popFront();

      Remove the first listener or throw an error if there are no listeners. Part of the bidirectional range interface.

    • prepend

      Declaration

      void prepend(T[] listeners...);

      Prepend listeners to the listener collection.

      Parameters

      T[] listeners

      The listeners to insert.

    • back

      Declaration

      const T back();

      Get the last listener or throw an error if there are no listeners. Part of the bidirectional range interface.

    • popBack

      Declaration

      void popBack();

      Remove the last listener or throw an error if there are no listeners. Part of the bidirectional range interface.

    • append

      Declaration

      void append(T[] listeners...);

      Appends a listener to the listener collection.

      Parameters

      T[] listeners

      The listeners to insert.

    • remove

      Declaration

      void remove(T[] listeners...);

      Removed all occurrences of the given listeners.

      Parameters

      T[] listeners

      The listeners to remove.

    • clear

      Declaration

      void clear();

      Clears all listeners.

    • call

      Declaration

      void call(ParamTypes params);

      Calls all the registered listeners in order.

      Parameters

      ParamTypes params

      The param tuple to call the listener with.

    • opCall

      Declaration

      void opCall(ParamTypes params);

      Aliases call.

    • save

      Declaration

      auto save();

      Copies the event to allow multiple range-like iteration. Part of the bidirectional range interface.

    • opSlice

      Declaration

      auto opSlice();

    • opOpAssign

      Declaration

      void opOpAssign(string s : "~")(T listener);

      Aliases append.

    • opOpAssign

      Declaration

      void opOpAssign(string s : "-")(T listener);

      Aliases remove.